/**
 * com.chaeron.GPS - An API for access to GPS devices.
 *
 *
 * Copyright (c) 2001, 2002 Chaeron Corporation,
 * All rights reserved.
 * 
 * Chaeron grants you a non-exclusive license to use, modify and re-distribute
 * this program under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version, provided that this copyright notice and 
 * license appear on all copies of the software.
 * 
 * Software is provided "AS IS," without a warranty of any kind. ALL EXPRESS OR
 * IMPLIED REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE
 * HEREBY EXCLUDED. THE ENTIRE RISK ARISING OUT OF USING THE SOFTWARE IS ASSUMED
 * BY THE LICENSEE. See the GNU General Public License for more details.
 *
 * CHAERON AND ITS LICENSORS SHALL NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY
 * LICENSEE OR ANY THIRD PARTY AS A RESULT OF USING OR DISTRIBUTING SOFTWARE.
 * IN NO EVENT WILL CHAERON OR ITS LICENSORS BE LIABLE FOR ANY LOST REVENUE,
 * PROFIT OR DATA, OR FOR DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL
 * OR PUNITIVE DAMAGES, HOWEVER CAUSED AN REGARDLESS OF THE THEORY OF LIABILITY,
 * ARISING OUT OF THE USE OF OR INABILITY TO USE SOFTWARE, EVEN IF CHAERON HAS
 * BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

 * @version     1.02
 * @author      Andrzej Jan Taramina, Chaeron Corporation
 *              andrzej@chaeron.com
 */

package com.chaeron.GPS.Garmin;

//***************************************************************************
//*
//*     Imports
//*
//***************************************************************************/

import com.chaeron.GPS.*;
import com.chaeron.GPS.exception.*;


//***************************************************************************
//*
//*     CommandGarminPacket Class definition
//*
//***************************************************************************/

/**
 * The CommandGarminPacket class represents Command Packets
 *
 */

public class CommandGarminPacket extends GarminPacket
{
	//***************************************************************************
	//*
	//*     Constant definitions
	//*
	//***************************************************************************/
	
	
	//***************************************************************************
	//*
	//*     Attributes
	//*
	//***************************************************************************/
	
	private short		appProtocol		= 0;
	private byte		commandType		= 0;
	
	
	//***************************************************************************
	//*
	//*     Constructors
	//*
	//***************************************************************************/
	
	/**
	 * Create a default CommandGarminPacket instance
	 *
	 * @param	protocol	protocol object
	 */
	
	public CommandGarminPacket( Protocol protocol )
	{  
		super( (byte)0, new byte[] { 0, 0 }, 2 );
		
		setPacketIDByte( protocol.getProtocolPacketID( Protocol.GARMIN_PID_COMMAND ) );
	}
	
	
	/**
	 * Create a CommandGarminPacket from the given packet data
	 *
	 * @param	packet		packet data buffer
	 * @param	len			length of packet data
	 */
	
	CommandGarminPacket( byte[] packet, int len )
	{  
		super( packet, len );
	}
	
	
	//***************************************************************************
	//*
	//*     Packet Processing Methods
	//*
	//***************************************************************************/
	
	/**
	 * Process the packet
	 *
	 * @param	gps			the GPS object that requested the packet to be processed
	 */
	
	void process( GPS gps )
	{
		// Do nothing
	}
	
	
	//***************************************************************************
	//*
	//*     Methods
	//*
	//***************************************************************************/
	
	/**
	 * Set command type
	 *
	 * @param	type		command type
	 * @param	protocol	protocol object
	 * @return				true if operation succeeded, false if command unavailable
	 */
	
	boolean setCommandType( byte type, Protocol protocol )
	{
		byte	commandID;
		
		commandType = type;
		
		commandID = protocol.getCommandID( type );
		
		if( commandID != Protocol.COMMAND_UNAVAILABLE ) {
			packetBuffer[ PACKET_DATA ] = commandID;
			setChecksum();
		}
		
		return( commandID != Protocol.COMMAND_UNAVAILABLE );
	}
	
	
	/**
	 * Get the Packet ID as a string for the current link protocol
	 *
	 * @param	protocol		protocol object
	 * @return					Packet ID (as string)
	 */
	
	public String getPacketIDString( Protocol protocol )
	{
		String		idStr	= super.getPacketIDString( protocol );
		String		cmdStr	= null;
		
		cmdStr = protocol.getCommandIDString( commandType );
		
		if( cmdStr != null ) {
			idStr += " - " + cmdStr;
		}
		
		return( idStr );   
	}
	
	
}
